Search AD Groups

Search for security groups in the Active Directory

Method

/API2/access/searchAdGroups

  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2018.5
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin

Method Signature

Input Parameters

Name

searchdata

Object Type

LdapSearchObject

Description

The LDAP search object that contains the parameters to be used in Active Directory searches.

Output Response

Successful Result Code

200

Response List Type

LdapGroupDetails[]

Description of Response Type

LDAP Group object with details of the groups found in the search.. Note that the response is returned as a list of items of this object type.

Notes

This feature is useful for finding groups in the Active Directory to add to the system. It is only functional when using the Active Directory as the authentication provider